• All Files

Defining a New Query Parameter

Query parameter is a single value that returns from a query to a specific connection provider. In the Test Query table, a query parameter appears in the cell located at the intersection of the first column with the first row.

 

Note: The query syntax depends on the specific connector. Please refer to the connector provider description for SQL query syntax.

 

Query Parameter Sample

After selecting the New Query Parameter option, the Edit Parameter page opens.

Query Parameter Sample

The Edit Parameter (Query Parameter) page has the following fields:

Fields Description Comments

Name

The Query Parameter name

Enter parameter name of your choice.

Stop Interface

Execution if No

Result

If the checkbox is selected, the interface will suspend the run if no value is returned when the query is performed.

Enable the checkbox to exclude the interface from execution if the query parameter is empty.

Connection

The Connection used for data querying.

Select the required connection from the drop-down list.

SQL

An SQL query field. The query syntax depends on the connection used.

 

Write the query that will retrieve the required data.

Test Query

Allows testing the query performance.

Click the button to get the query parameter result (the first cell in the table).

Default Value

User-defined value to be used by default if the SQL does not return any value.

Insert the value of your choice.

 

To define a new system parameter, follow steps 1-3 in the introduction to this section and then proceed below:

  1. In the Name field, insert the new query parameter name.
  2. Click Stop Interface Execution if No Result to disable the interface for execution if the SQL query doesn’t return any result. 
  3. Select a Connection from the list. 
  4. In the SQL box, type an SQL query. 
  5. Click Test Query to test the performance of the query (optional)
  6. In the Default Value field, insert the new query parameter value of your choice (optional).
  7. Click Save to keep the parameter, Save & Close to keep and close the parameter, and end the session, or Click Save & New to save and close the current parameter and begin a new session.